// --------------------------------------------------------------------------------------------------------------------
// <copyright file="FirmwareException.cs" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------
namespace Microsoft.Robotics.Hardware.EV4
{
    using System;
    using System.Runtime.Serialization;

    /// <summary>
    /// A Firmware Exception
    /// </summary>
    [Serializable]
    public class FirmwareException : Exception
    {
        /// <summary>
        /// Name for response code value in serialization info.
        /// </summary>
        private const string ResponseCodeName = "ResponseCode";

        /// <summary>
        /// The response code sent by the firmware
        /// </summary>
        private int responseCode;

        /// <summary>
        /// Initializes a new instance of the <see cref="FirmwareException" /> class.
        /// </summary>
        /// <param name="responseCode">The response code sent by the firmware</param>
        public FirmwareException(int responseCode)
        {
            this.responseCode = responseCode;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="FirmwareException"/> class.
        /// </summary>
        /// <param name="info">Serialization info.</param>
        /// <param name="context">Streaming context.</param>
        protected FirmwareException(SerializationInfo info, StreamingContext context)
            : base(info, context)
        {
            if (info == null)
            {
                throw new ArgumentNullException("info");
            }

            this.responseCode = info.GetInt32(ResponseCodeName);
        }

        /// <summary>
        /// Gets the response code
        /// </summary>
        public int ResponseCode
        {
            get
            {
                return this.responseCode;
            }
        }

        /// <summary>
        /// Perform custom serialization (none)
        /// </summary>
        /// <param name="info">Serialization info</param>
        /// <param name="context">Serialization context</param>
        public override void GetObjectData(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context)
        {
            base.GetObjectData(info, context);

            info.AddValue(ResponseCodeName, this.responseCode);
        }
    }
}
